Title Banner

Previous Book Contents Book Index Next

Inside Macintosh: OpenDoc Class Reference /
Part 1 - Classes and Methods / ODStorageUnitRefIterator


First

The First method begins the iteration and obtains a copy of the first persistent reference, if it exists, in the currently focused value of the storage unit.

void First (out ODStorageUnitRef ref);
ref
A copy of the first persistent reference in the currently focused value of the storage unit. If the focused value contains no persistent references, the return value is undefined.
DISCUSSION
Your part must call this method before calling the IsNotComplete method for the first time. This method may be called multiple times; each time resets the iteration.

It is your responsibility to deallocate the returned persistent reference when it is no longer needed.

EXCEPTIONS
kODErrIteratorOutOfSync
The focused value was modified while the iteration was in progress.
SEE ALSO
The ODStorageUnitRef type (page 903).


Previous Book Contents Book Index Next

© Apple Computer, Inc.
17 JUL 1996




Navigation graphic, see text links

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help